mobileComposeHtmlMail
Type
command
Summary
Opens a new email message in the user's email program.
Syntax
mobileComposeHtmlMail <subject>, [<recipients>, [<ccs>, [<bccs>, [<body>, [<attachments>]]]]]
Description
Use the mobileComposeHtmlMail command to create an HTML email message with attachments from within a stack on iOS or Android.
This command interfaces with the iOS and Android mail composition interface
If you specify a file for the attachment, the engine tries to use the least amount of memory by asking the operating system to only load it from disk when the file is needed. Therefore, using mobileComposeHtmlMail should be the preferred method when attaching large amounts of data to an e-mail. For example, sending multiple attachments may be done like this:
put \"Hello World!\" into tAttachments[1][\"data\"]
put \"text/plain\" into tAttachments[1][\"type\"]
put \"Greetings.txt\" into tAttachments[1][\"name\"]
put \"Goodbye World!\" into tAttachments[2][\"data\"]
put \"text/plain\" into tAttachments[2][\"type\"]
put \"Farewell.txt\" into tAttachments[2][\"name\"]
mobileComposeHtmlMail tSubject, tTo, tCCs, tBCCs, tBody, tAttachments
Some devices are not configured with e-mail sending capability. To determine if the current device is, use the mobileCanSendMail function. This returns true if the mail client is configured.
Once the mobileComposeHtmlMail command is called, you have no more control over what the user does with the message. They are free to modify the message and the addresses as they see fit.
Parameters
| Name | Type | Description |
|---|---|---|
subject | The subject line of the email. | |
recipients | A comma delimited list of email addresses to be placed in the 'To' field. | |
ccs | A comma delimited list of email addresses to be placed in the 'CC' field. | |
bccs | A comma delimited list of email addresses to be placed in the 'BCC' field. | |
body | The HTML body text of the email. | |
attachments | array | empty to send no attachments, a single attachment array or a one-based numeric array of attachment arrays to include. The attachments parameter consists of either a single array, or an array of arrays listing the attachments to include. A single attachment array should consist of the following keys:
|
Examples
mobileComposeHtmlMail "Test E-mail", "guido@example.net",,, "This is the bold <b>e-mail body</b> text", tAttachment
mobileComposeHtmlMail "Help", "help@example.com",,,field "Message"
put "Hello World!" into tAttachment["data"]
put "text/plain" into tAttachment["type"]
put "Greetings.txt" into tAttachment["name"]
mobileComposeHtmlMail "Greetings", "test@livecode.com",,,, tAttachment
Related
command: revMail, revGoURL, revMailUnicode, mobileComposeUnicodeMail, mobileComposeMail
function: mobileCanSendMail
glossary: command
object: stack
Compatibility and Support
Introduced
LiveCode 4.6
OS
ios
android
Platforms
mobile